Conversation
dishaprakash
added
the
release candidate
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for Generic OIDC Authentication, detailing its configuration, behavior, and field references. The review feedback identifies two areas for improvement: correcting a broken and inaccurate sentence in the token validation flow description and clarifying in the reference table that scope validation is only enforced when mcpEnabled is set to true. Both comments include specific code suggestions to address these points.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/en/documentation/configuration/authentication/generic.md (33-34)
This sentence appears to be broken and contains information that is not entirely accurate for the described token validation flow. The scope claim is only validated when mcpEnabled is true, but this section describes the behavior for when it's false (as per the example and the header used to extract the token). To improve clarity and correctness, I suggest correcting the sentence to focus only on audience validation, which is performed in this flow. Please verify this against the implementation as automated analysis may incorrectly report discrepancies.
4. Verify that the aud (audience) claim matches the configured audience.
References
- When analyzing code snippets in a documentation file, consider the entire document's context, as variables may be defined in earlier code blocks and reused in subsequent ones.
- Automated analysis may incorrectly report discrepancies between documentation and code; always verify its findings before acting on them.
docs/en/documentation/configuration/authentication/generic.md (67)
The description for scopesRequired is a bit misleading. Based on the implementation, scopes are only validated when mcpEnabled is set to true. To avoid confusion, it would be helpful to clarify this condition in the description. Please verify this against the implementation as automated analysis may incorrectly report discrepancies.
| scopesRequired | []string | false | A list of required scopes that must be present in the token's scope claim to be considered valid. Only enforced when mcpEnabled is true. |
References
- Automated analysis may incorrectly report discrepancies between documentation and code; always verify its findings before acting on them.
|
🚀 Cloudflare Preview Ready! 🔎 View Preview: https://pr-2866.toolbox-docs-6xc.pages.dev (Note: Subsequent pushes to this PR will automatically update the preview at this same URL) |
|
🧨 Preview deployments removed. Cloudflare Pages environments for |
## Description Move new auth doc to new path ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [ ] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> ee70433
## Description Move new auth doc to new path ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [ ] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> ee70433
## Description Move new auth doc to new path ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [ ] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> ee70433
## Description Move new auth doc to new path ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [ ] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> ee70433
2 participants
Description
Move new auth doc to new path
PR Checklist
CONTRIBUTING.md
bug/issue
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
!if this involve a breaking change🛠️ Fixes #<issue_number_goes_here>